home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / reward17.zip / REWARD17.DOC < prev    next >
Text File  |  1992-12-03  |  16KB  |  384 lines
  1.  
  2.  
  3.  
  4.  
  5.                                 PCB-REWARD 
  6.                                Documentation
  7.                               
  8.                                 Version 1.7
  9.                                  12-02-92
  10.  
  11.                              Copyright 1991, 1992
  12.  
  13.                                 Tom Gregory
  14.                                
  15.  
  16.  
  17.                              All Rights Reserved
  18.                            
  19.  
  20. PCB-REWARD --- What is it?
  21.  
  22. PCB-REWARD is a PCBoard version 14.5 utility to allow the SYSOP to
  23. reward the top uploaders with extra time and/or download bytes.  The
  24. users are scan checked nightly.  I have found that this makes uploading 
  25. into a contest for the top slot for some users and has actually
  26. increased my uploads dramatically.
  27.  
  28. PCB-REWARD runs in your nightly event.  It scans your users file
  29. and selects the top uploaders for the reward.  It then changes
  30. their security level to one that you have selected for them.  It
  31. also writes a bulletin and/or news file which announces who these
  32. top people are and prods others to compete for the slots.
  33.  
  34. PCB-REWARD is FULLY FUNCTIONAL and is not crippled in any way.  If 
  35. you elect to have the bulletin and/or news file generated, a line will 
  36. be appended to the end of them which states that it is an evaluation copy.  
  37. Once registered, this line will not appear.
  38.  
  39. You may now select the number of rewards to issue, up to a maximum
  40. of 99. 
  41.  
  42.  
  43. *****************  WARNING TO PREVIOUS VERSION USERS  *************
  44.  
  45. This version uses a totally different routine to scan and reward
  46. the users.  It is IMPERATIVE that you run your old version using
  47. the /NEW switch prior to running this version!  If you do not, it
  48. will corrupt your users file!!!!
  49.  
  50. Run as:   REWARDxx REWARD.CFG /NEW
  51.                 x = version number you are currently running
  52.                 Be sure to use your normal .CFG file name
  53.  
  54. *******************************************************************
  55.  
  56.  
  57. HOW TO USE
  58.  
  59. NOTE:  ALL NODES SHOULD BE DOWN BEFORE RUNNING THIS UTILITY.  
  60. ------------------------------------------------------------
  61.  
  62. PCB-REWARD is simple to use.  In your EVENT.SYS file, place a line
  63. that says:
  64.  
  65.     REWARDxx REWARD.CFG    (xx = version number)
  66.     
  67. This will update your top uploader(s) every night.  If a user falls
  68. out of one of the slots, their security level is returned what they
  69. had before the reward.  
  70.  
  71. The REWARD.CFG is a fairly standard configuration file.  I have
  72. included a file called SAMPLE.CFG and a file called REWARD.CFG. 
  73. SAMPLE.CFG is the same as REWARD.CFG, except it is commented.
  74.  
  75. Simply make the changes to REWARD.CFG that conform to your BBS
  76. structure and your option selections.  A word of caution.  The data
  77. in the .CFG file MUST  be in the exact order as presented.  You may
  78. rename the .CFG file, but be sure that you change the command line
  79. in your EVENT.SYS to call the correct .CFG  file at execution time.
  80.  
  81. You may also run this program from the DOS prompt by simply typing
  82. in the command line as it appears in the EVENT.SYS file.  
  83.  
  84. CONFIGURATION FILE
  85.  
  86. Here is the .CFG file format:
  87.  
  88. Software Heaven BBS  ;Name of your BBS or Registered name
  89. 00000                ;Registration Num (00000 if unregistered
  90. c:\pcb\main\users    ;Complete path to users file
  91. 90                   ;Maximum Security to include in scan. See SAMPLE.CFG
  92. 5                    ;Number of rewards to issue. Max number is 99
  93. 75                   ;Security level to give Top Uploader
  94. 65                   ;Security level to give remaining Uploaders
  95. c:\pcb\gen\blt5      ;Complete path for Bulletin
  96. c:\pcb\gen\news      ;Complete path for News file
  97. y                    ;Vanity Flag - Set to Y or N  
  98. 3                    ;Bulletin/News creation flag  
  99. y                    ;Future use - must include
  100. 5                    ;Future use - must include
  101.  
  102.  
  103. See SAMPLE.CFG for a complete description of each of these lines.
  104.  
  105.  
  106.  
  107. SETUP
  108.  
  109. Once you have set up the .CFG file, copy the following files to a
  110. subdirectory or into your main PCB subdirectory.  If you place them
  111. in their own subdirectory, be sure to path to it in your EVENT.SYS
  112. file.
  113.  
  114.  
  115. Files to copy are:
  116.  
  117.           REWARD##.EXE
  118.           REWARD.USR
  119.           REWARD.CFG
  120.           REWBULT.TXT
  121.  
  122. If you wish to use the user specific menus to tell the rewarded
  123. users that they have been rewarded, copy the BRDMxx files to the
  124. same directory as the rest of your BRDM files.
  125.           
  126. Next, you must make entries in your PWRD file to reflect the
  127. rewarded security levels.  In our example, we used 75 for the top
  128. uploader and 65 for the other users.  If we wanted to give our top
  129. uploader 120 minutes per day and unlimited downloads, we would
  130. enter these figures into the PWRD file. PCB-REWARD will then change
  131. the top user's security level to 75.  Do the same for the other
  132. users.  The amount on privilege that you award is strictly up to
  133. you.  
  134.  
  135. That's all there is to it.
  136.  
  137.  
  138. SWITCHES
  139.  
  140. There is only one(1) switch available in PCB-REWARD.  That is the
  141. /NEW switch.  Case is unimportant.  This switch causes the program
  142. to set the  USERS file back to a non-rewarded status.  All rewarded
  143. users are set back to their original security levels and no new
  144. users are rewarded.  You may want to use this switch to start over
  145. from scratch. 
  146.  
  147. NOTE: You MUST use this switch when upgrading from one 
  148. version to another, and then re-run PCB-REWARD as normal.
  149.  
  150. The syntax is as follows:
  151.  
  152.      REWARDxx REWARD.CFG /NEW
  153.  
  154. MENUS
  155.  
  156. You may want to create special security specific menus for the
  157. users. I have included main menus for the 2 levels that are shown
  158. in the .CFG file.  You may either change them from BRDMxx to
  159. whatever level you are awarding, create your own, or not use them
  160. at all.
  161.  
  162.  
  163. BULLETINS
  164.  
  165. The included file, REWBULT.TXT, is a sysop definable bulletin file.
  166. This name is hard-coded into the software.  It is the file that the 
  167. REWARD calls to make the actual bulletin.  You may change it
  168. to whatever 'look' that you want, as long as a few rules are followed. 
  169. It may be written using any drawing utility or editor and uses the " 
  170. @X## " codes that PCB 14.5 supports. 
  171.  
  172. *** NOTE TO VERSION 1.5 AND EARLIER USERS ***
  173.  
  174. This version has changed the character used to identify where the
  175. user's names should be placed.  Previous versions used a # sign. 
  176. We now use the tilde mark ~.  Be sure to change your REWBULT.TXT
  177. file to reflect this change.  This change was made to allow you to
  178. use the # sign with your descriptor titles.  Also, Be sure to put a
  179. BACKARDS APOSTROPHE  ` in as the last character in the REWBULT.TXT file.
  180. This is a MUST !  See explaination later in this section.
  181.  
  182. *******************************
  183.  
  184. The following format is used to imbed the users names in. 
  185.  
  186.      ~1 = Top Uploader   ~2 - ~99 are the other uploaders.  
  187.  
  188. Just place the tilde and number in the spot that you want that user's name 
  189. to appear.  Note that there can be NO space between the tilde and the number.
  190. PCB-REWARD will call this file and substitute the selected names in place of 
  191. the tilde/number combination when it writes the bulletin.  Note that if the 
  192. Vanity flag in the .CFG file is set to yes (y), a copyright line will be
  193. added to the bottom of the bulletin.  
  194.  
  195. The newest feature of REWARD is the ability to show the number of uploads a 
  196. user has made, in the bulletin.  A couple of issues need to be addressed 
  197. concerning this.  First, the place marker for the uploads is the CARAT ( ^ )
  198. symbol.  Unlike the user name, no number is placed after the carat.  The 
  199. program looks for the carat mark and if it sees one, it writes the number of 
  200. uploads for the last user name that it has written to the bulletin file.  In 
  201. other words, if you place the top uploaders name in the bulletin, but not his 
  202. number of uploads and, then later place the 2nd users name followed by the 
  203. carat, it should automatically place the correct number of uploads for the 
  204. 2nd user at the selected place.  
  205.  
  206. One note to remember:  You need to place the carat at least 25 spaces or so 
  207. after the name if it's on the same line, to allow for the largest available 
  208. user name.  The program tries to place the upload number in the relative 
  209. position as in the REWBULT.TXT, regardless of the length of the user name.  
  210. So if the user name is longer than the distance between the ~xx name place 
  211. marker and the carat ^ marker, the upload number will overwrite the end of 
  212. the users name.
  213.  
  214. So, if you change the format of the REWBULT.TXT file, you may have to 
  215. experiment with the format.  
  216.  
  217. Here's another example: if user numbers are placed in 2 or more columns with 
  218. several spaces between them, the results may be less than satisfactory.  Look 
  219. at the example below:
  220.  
  221.     ~2          ~3
  222.     ~4          ~5
  223.  
  224. This will result in the placement of the following example names
  225. as:
  226.  
  227.     Joe Modem          Jim Sysop 
  228.     Susie Computer         Sam Byte
  229.  
  230. If you want several names on a single line, I would suggest use a comma 
  231. and SINGLE space between each name on a line.  
  232.  
  233.  ~2, ~3, ~4
  234.  ~5, ~6, ~7
  235.  
  236. The above formats make for a better visual appearance.
  237.  
  238. You also MUST have a BACKWARDS APOSTROPHE as the last character in 
  239. the REWBULT.TXT file.  This mark tells the program where the end is and
  240. where the News file will start.  Also, see the discussion on this mark
  241. in the NEWS section below.
  242.  
  243. NEWS FILE GENERATION
  244.  
  245. You now have the ability to place the REWBULT.TXT message at the
  246. top of your NEWS file as part of the nightly event.  To enable this
  247. feature, the flag at line 11 of the .CFG file must be set to 2 or
  248. 3.  You must also use a text editor to modify your existing NEWS
  249. file before you use this feature the first time. (Note: you only
  250. have to modify it once).  Simply insert a ` mark as the very first
  251. character of your existing news file.  Note that this mark is the
  252. BACKWARDS APOSTROPHE and NOT the regular apostrophe.  It is usually
  253. located on the same key as the tilde.  If you have separate files
  254. for color and non-graphics modes, be sure to include it in both.  This 
  255. one-time chore is in addition to the ` which you have placed in the 
  256. REWBULT.TXT file.  The only other time you have to add this mark is
  257. when you edit the actual news file.. See below.
  258.  
  259. Once this is done, PCB-REWARD will scan your News file and disregard 
  260. everything until it finds the backward apostrophe.  It will then start 
  261. saving the info (your original news file) into a temp file.  It then writes 
  262. the REWBULT.TXT file to the news file, inserting the proper users names, 
  263. and then appends the old news info back to the new News File.
  264.  
  265. This way, the Reward info gets updated nightly without affecting
  266. your existing news.
  267.  
  268. The only problem that this may cause you, is that you will need to
  269. manually delete the reward portion of the news file before you add
  270. new news.  Be sure to leave the ` mark in the new, modified news
  271. file so that the reward bulletin will be added back on top the next
  272. time PCB-REWARD runs.  
  273.  
  274. If you add news in front of the reward news section, the new
  275. portion will be deleted when the nightly event re-writes it.  This
  276. was not done deliberately, but is simply an effect of the way it
  277. handles the news file merge.
  278.  
  279. I am also working on a feature to allow you to embed the bulletin
  280. any place in the news file, which will correct this problem.
  281.  
  282. NOTE:  In order to make space between the reward announcement and the news 
  283. file itself, you may place blank lines AFTER the backwards apostrophe.  You 
  284. MUST make each blank line contain at least 1 space character for the blank 
  285. line to show up in the new News file.  This is just like entering messages 
  286. in the normal message mode in PCBoard.
  287.  
  288. REGISTRATION
  289.  
  290. Registration may be accomplished by printing and filling out the
  291. included form, REGISTER.DOC, and mailing it to the address
  292. indicated.  Please enclose  a fee of $10.00.  Make checks payable
  293. to TOM GREGORY.
  294.  
  295. Once I receive these items, I will send you a registration number
  296. which you will need to place in the .CFG file.  This will eliminate
  297. the evaluation message in the bulletins and news files. 
  298.  
  299. BE SURE TO PRINT THE REGISTRATION NAME EXACTLY AS YOU WANT IT TO
  300. APPEAR IN THE .CFG FILE.
  301.  
  302. Registration also entitles you to receive telephone support, as
  303. well as all future updates.  On the registration form, be sure to
  304. include a password for pre-registration on Software Heaven BBS. 
  305. This will allow you to have Visiting Sysop privileges.
  306.  
  307. Registration will also let you sleep better at night !
  308.  
  309.  
  310. If you have questions or problems, you may contact me via the below
  311. method.
  312.  
  313.                
  314.                Tom Gregory
  315.                5278 Tracy Ct.
  316.                Stone Mountain, Ga.  30083
  317.                     
  318.                      or
  319.                          
  320.                Software Heaven BBS
  321.                404-413-6579
  322.                
  323.                Leave a message for me.
  324.                      
  325. ORIGINAL DISTRIBUTION
  326.  
  327. The original distrib contains the following files.  If you pass a
  328. copy of this program to another BBS or another user, please be sure
  329. to include the entire  set.
  330.  
  331.  
  332.           REWARD##.EXE --- The main program
  333.           REWARD.CFG --- Configuration file
  334.           REWARD.USR --- File that stores current top uploaders
  335.           REWARD.DOC --- This manual
  336.           SAMPLE.CFG --- Commented config file
  337.           REWBULT.TXT -- Text file containing the user-definable
  338.                          bulletin
  339.           BLT5       --- Sample Bulletin created by program
  340.           BRDMxxx    --- Sample main board security specific menus 
  341.           REGISTER.FRM - Registration Form
  342.           README.NEW --- Latest features
  343.           HISTORY.TXT -- Revision history
  344.                
  345. If the package that you received does not contain these files,
  346. please advise  the SYSOP of the BBS you received it from that the
  347. package is incomplete.
  348.  
  349. I hate the legal mumbo-jumbo stuff, but it's gotta be there, so
  350. here goes..
  351.  
  352.  
  353.                         COPYRIGHT NOTICE AND DISCLAIMER
  354.  
  355. This software is released as Shareware.   It may be copied and
  356. given to other users as long as all of the files contained in the
  357. original distribution are intact.
  358.  
  359. The user is expected to register this software after a reasonable amount of use, when said use determines that this software has
  360. value to the user, or the user will continue to use this software. 
  361. It is generally accepted that a "reasonable amount of use" should
  362. not exceed 30 days.  At the end of this  period, the user shall
  363. either register this software with the author by submitting the
  364. required fee, or the user shall totally discontinue all use of the
  365. software.  The user also agrees that they shall make no attempt to 
  366. disassemble, modify, tamper with or alter the software in any way. 
  367.  
  368.  
  369. The user further agrees that registration shall authorize them for
  370. the use of this software on one (1) computer system only, at any
  371. one time.  Each additional computer system which also contains this
  372. software must have its own registered copy.  
  373.  
  374. The author of this software is providing it on an as-is basis.  
  375. The author has made every effort to assure that this software will
  376. perform as stated. However, no guarantees are made or implied as to
  377. its usability or functionality.  The author is in no way liable for
  378. any damage caused by the use of this software, either directly or
  379. indirectly.  The user agrees to hold the author harmless for any
  380. problems which may be caused by the use of this software on their
  381. computer system.  However, the author will make every effort  to
  382. assist users with problems should they arise.
  383.  
  384.